/*! \file bcmport_util.h
 *
 * PORT component utility function.
 */
/*
 * Copyright: (c) 2018 Broadcom. All Rights Reserved. "Broadcom" refers to 
 * Broadcom Limited and/or its subsidiaries.
 * 
 * Broadcom Switch Software License
 * 
 * This license governs the use of the accompanying Broadcom software. Your 
 * use of the software indicates your acceptance of the terms and conditions 
 * of this license. If you do not agree to the terms and conditions of this 
 * license, do not use the software.
 * 1. Definitions
 *    "Licensor" means any person or entity that distributes its Work.
 *    "Software" means the original work of authorship made available under 
 *    this license.
 *    "Work" means the Software and any additions to or derivative works of 
 *    the Software that are made available under this license.
 *    The terms "reproduce," "reproduction," "derivative works," and 
 *    "distribution" have the meaning as provided under U.S. copyright law.
 *    Works, including the Software, are "made available" under this license 
 *    by including in or with the Work either (a) a copyright notice 
 *    referencing the applicability of this license to the Work, or (b) a copy 
 *    of this license.
 * 2. Grant of Copyright License
 *    Subject to the terms and conditions of this license, each Licensor 
 *    grants to you a perpetual, worldwide, non-exclusive, and royalty-free 
 *    copyright license to reproduce, prepare derivative works of, publicly 
 *    display, publicly perform, sublicense and distribute its Work and any 
 *    resulting derivative works in any form.
 * 3. Grant of Patent License
 *    Subject to the terms and conditions of this license, each Licensor 
 *    grants to you a perpetual, worldwide, non-exclusive, and royalty-free 
 *    patent license to make, have made, use, offer to sell, sell, import, and 
 *    otherwise transfer its Work, in whole or in part. This patent license 
 *    applies only to the patent claims licensable by Licensor that would be 
 *    infringed by Licensor's Work (or portion thereof) individually and 
 *    excluding any combinations with any other materials or technology.
 *    If you institute patent litigation against any Licensor (including a 
 *    cross-claim or counterclaim in a lawsuit) to enforce any patents that 
 *    you allege are infringed by any Work, then your patent license from such 
 *    Licensor to the Work shall terminate as of the date such litigation is 
 *    filed.
 * 4. Redistribution
 *    You may reproduce or distribute the Work only if (a) you do so under 
 *    this License, (b) you include a complete copy of this License with your 
 *    distribution, and (c) you retain without modification any copyright, 
 *    patent, trademark, or attribution notices that are present in the Work.
 * 5. Derivative Works
 *    You may specify that additional or different terms apply to the use, 
 *    reproduction, and distribution of your derivative works of the Work 
 *    ("Your Terms") only if (a) Your Terms provide that the limitations of 
 *    Section 7 apply to your derivative works, and (b) you identify the 
 *    specific derivative works that are subject to Your Terms. 
 *    Notwithstanding Your Terms, this license (including the redistribution 
 *    requirements in Section 4) will continue to apply to the Work itself.
 * 6. Trademarks
 *    This license does not grant any rights to use any Licensor's or its 
 *    affiliates' names, logos, or trademarks, except as necessary to 
 *    reproduce the notices described in this license.
 * 7. Limitations
 *    Platform. The Work and any derivative works thereof may only be used, or 
 *    intended for use, with a Broadcom switch integrated circuit.
 *    No Reverse Engineering. You will not use the Work to disassemble, 
 *    reverse engineer, decompile, or attempt to ascertain the underlying 
 *    technology of a Broadcom switch integrated circuit.
 * 8. Termination
 *    If you violate any term of this license, then your rights under this 
 *    license (including the license grants of Sections 2 and 3) will 
 *    terminate immediately.
 * 9. Disclaimer of Warranty
 *    THE WORK IS PROVIDED "AS IS" WITHOUT WARRANTIES OR CONDITIONS OF ANY 
 *    KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WARRANTIES OR CONDITIONS OF 
 *    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE OR 
 *    NON-INFRINGEMENT. YOU BEAR THE RISK OF UNDERTAKING ANY ACTIVITIES UNDER 
 *    THIS LICENSE. SOME STATES' CONSUMER LAWS DO NOT ALLOW EXCLUSION OF AN 
 *    IMPLIED WARRANTY, SO THIS DISCLAIMER MAY NOT APPLY TO YOU.
 * 10. Limitation of Liability
 *    EXCEPT AS PROHIBITED BY APPLICABLE LAW, IN NO EVENT AND UNDER NO LEGAL 
 *    THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE 
 *    SHALL ANY LICENSOR BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY DIRECT, 
 *    INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF 
 *    OR RELATED TO THIS LICENSE, THE USE OR INABILITY TO USE THE WORK 
 *    (INCLUDING BUT NOT LIMITED TO LOSS OF GOODWILL, BUSINESS INTERRUPTION, 
 *    LOST PROFITS OR DATA, COMPUTER FAILURE OR MALFUNCTION, OR ANY OTHER 
 *    COMMERCIAL DAMAGES OR LOSSES), EVEN IF THE LICENSOR HAS BEEN ADVISED OF 
 *    THE POSSIBILITY OF SUCH DAMAGES.
 */

#ifndef BCMPORT_UTIL_H
#define BCMPORT_UTIL_H

/*******************************************************************************
 * Includes
 */
#include <shr/shr_types.h>
#include <shr/shr_bitop.h>
#include <bcmdrd_config.h>
#include <bcmdrd/bcmdrd_types.h>
#include <bcmltd/bcmltd_types.h>
#include <bcmbd/bcmbd.h>
#include <bcmptm/bcmptm_types.h>

/*! Port Identifier.  */
typedef int bcmport_id_t;

/*!
 * \brief This macro is used to set a Field present indicator bit status.
 *
 * Sets the Field \c _f present bit indicator in the Field Bitmap \c _m.
 *
 * \param [in] _m Field bitmap.
 * \param [in] _f Field position in the bitmap.
 *
 * \returns Nothing.
 */
#define BCMPORT_LT_FIELD_SET(_m, _f)    \
            do {                        \
                SHR_BITSET(_m, _f);;      \
            } while (0)

/*!
 * \brief This macro is used to get the Field present indicator bit status.
 *
 * Returns the Field \c _f present bit indicator status from the Field
 * Bitmap \c _m.
 *
 * \param [in] _m Field bitmap.
 * \param [in] _f Field position in the bitmap.
 *
 * \returns Field present indicator bit status from the Field bitmap.
 */
#define BCMPORT_LT_FIELD_GET(_m, _f)  (SHR_BITGET(_m, _f))


/*!
 * \brief ECMP Logical Table Fields information.
 */
typedef enum bcmport_membership_policy_lt_fields_e {

    BCMPORT_MEMBERSHIP_POLICY_LT_FIELD_PORT_ID = 0,

    BCMPORT_MEMBERSHIP_POLICY_LT_FIELD_ING_VLAN_MEMBERSHIP_CHECK,

    BCMPORT_MEMBERSHIP_POLICY_LT_FIELD_EGR_VLAN_MEMBERSHIP_CHECK,

    BCMPORT_MEMBERSHIP_POLICY_LT_FIELD_SKIP_VLAN_CHECK,

    BCMPORT_MEMBERSHIP_POLICY_LT_FIELD_COUNT

} bcmport_membership_policy_fields_t;


#define MAX_PRI_CNT  8
#define MAX_TPID_CNT 4

/*! HA subcomponent ID for port mirror. */
#define BCMPORT_MIRROR_SUB_COMP_ID 1

/*! The maximum field count of PORT imm logical tables */
#define PORT_FIELD_COUNT_MAX 4

/*! The maximum field ID of PORT logical tables */
#define PORT_FIELD_ID_MAX 32

/*! Data structure to save the info of PORT_ING_MIRRORt entry */
typedef struct port_imirror_s {

    /*! Bitmap of Fileds to be operated */
    SHR_BITDCLNAME(fbmp, PORT_FIELD_ID_MAX);

    /*! Ingress logical port. */
    shr_port_t port;

    /*! Mirror instance ID. */
    uint32_t instance_id;

    /*! Enable/disable mirror. */
    bool enable;

} port_imirror_t;

/*! Data structure to save the info of PORT_EGR_MIRRORt entry */
typedef struct port_emirror_s {

    /*! Bitmap of Fileds to be operated */
    SHR_BITDCLNAME(fbmp, PORT_FIELD_ID_MAX);

    /*! Ingress logical port. */
    shr_port_t port;

    /*! Egress logical port. */
    shr_port_t egr_port;

    /*! Mirror instance ID. */
    uint32_t instance_id;

    /*! Enable/disable mirror. */
    bool enable;

} port_emirror_t;

/*! Data structure to save the info from PORT_BRIDGE LT entry. */
typedef struct port_bridge_info_s {
    /*! Bitmap of valid struct members. */
    uint32_t        member_bmp;
#define             MEMBER_BMP_PORT_ID         (1 << 0)
#define             MEMBER_BMP_BRIDGE          (1 << 1)

    /*! Ingress logical port. */
    shr_port_t      port;

    /*! Enable L2 bridging. */
    bool            bridge;
} port_bridge_info_t;

/*!
 * \brief Structure for ECMP Logical Table entry information.
 */
typedef struct port_membership_policy_info_s {
    /*! Bitmap of Fileds to be operated */
    SHR_BITDCLNAME(fbmp, PORT_FIELD_ID_MAX);

    /*! Store LT entry Port Identifier key field value. */
    bcmport_id_t      port_id;

    /*! Store LT entry Ingress Vlan Check filed value. */
    bool              ing_vlan_membership_check;

    /*! Store LT entry Egress Vlan Check filed value. */
    bool              egr_vlan_membership_check;

    /*! Store LT entry Vlan Check Skip field value. */
    bool              skip_vlan_check;
} port_membership_policy_info_t;

/*******************************************************************************
 * Public functions
 */
/*!
 * \brief Generic hw mem table read for BCMPORT.
 *
 * \param [in] unit Unit number.
 * \param [in] trans_id Transaction identifier.
 * \param [in] lt_id Logical table identifier.
 * \param [in] pt_id Memory table identifier.
 * \param [in] index Index of memory entry to read.
 * \param [out] entry_data Returned data value of entry.
 *
 * \retval SHR_E_NONE No errors.
 * \retval !SHR_E_NONE Failure.
 */
extern int
bcmport_pt_read(int unit, uint32_t trans_id, bcmltd_sid_t lt_id,
                bcmdrd_sid_t pt_id, int index, void *entry_data);

/*!
 * \brief Generic hw mem table write for BCMPORT.
 *
 * \param [in] unit Unit number.
 * \param [in] trans_id Transaction identifier.
 * \param [in] lt_id Logical table identifier.
 * \param [in] pt_id Memory table identifier.
 * \param [in] index Index of memory entry to write.
 * \param [in] entry_data New data value of entry to set.
 *
 * \retval SHR_E_NONE No errors.
 * \retval !SHR_E_NONE Failure.
 */
int
bcmport_pt_write(int unit, uint32_t trans_id, bcmltd_sid_t lt_id,
                 bcmdrd_sid_t pt_id, int index, void *entry_data);

/*!
 * \brief Generic hw reg table read for BCMPORT.
 *
 * \param [in] unit Unit number.
 * \param [in] trans_id Transaction identifier.
 * \param [in] lt_id Logical table identifier.
 * \param [in] pt_id Memory table identifier.
 * \param [in] index Index of memory entry to read.
 * \param [out] entry_data Returned data value of entry.
 *
 * \retval SHR_E_NONE No errors.
 * \retval !SHR_E_NONE Failure.
 */
extern int
bcmport_pr_read(int unit, uint32_t trans_id, bcmltd_sid_t lt_id,
                bcmdrd_sid_t pt_id, int index, void *entry_data);

/*!
 * \brief Generic hw reg table write for BCMPORT.
 *
 * \param [in] unit Unit number.
 * \param [in] trans_id Transaction identifier.
 * \param [in] lt_id Logical table identifier.
 * \param [in] pt_id Memory table identifier.
 * \param [in] index Index of memory entry to write.
 * \param [in] entry_data New data value of entry to set.
 *
 * \retval SHR_E_NONE No errors.
 * \retval !SHR_E_NONE Failure.
 */
int
bcmport_pr_write(int unit, uint32_t trans_id, bcmltd_sid_t lt_id,
                 bcmdrd_sid_t pt_id, int index, void *entry_data);
#endif /* BCMPORT_UTIL_H */
